Document gtk_parse_args limitations
authorMatthias Clasen <mclasen@redhat.com>
Sat, 30 Jan 2016 21:09:15 +0000 (16:09 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 30 Jan 2016 21:11:03 +0000 (16:11 -0500)
Mention that some things won't work without a display
connection.

gtk/gtkmain.c

index 2437ddce9ecaf3cd9fc5903d00e8d0ffe4ad372d..d3c3ba205733e8aafa9df25230436e372a415d16 100644 (file)
@@ -953,6 +953,10 @@ gtk_init_with_args (gint                 *argc,
  * There is no need to call this function explicitly if you are using
  * gtk_init(), or gtk_init_check().
  *
+ * Note that many aspects of GTK+ require a display connection to
+ * function, so this way of initializing GTK+ is really only useful
+ * for specialized use cases.
+ *
  * Returns: %TRUE if initialization succeeded, otherwise %FALSE
  */
 gboolean